<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>doc/README</title>
<meta name='robots' content='noindex,nofollow' />
<meta name='generator' content='GLOBAL-6.5.7' />
<meta http-equiv='Content-Style-Type' content='text/css' />
<link rel='stylesheet' type='text/css' href='../style.css' />
</head>
<body>
<!-- beginning of fixed guide -->
<div id='guide'><ul>
<li><a href='#TOP'><img class='icon' src='../icons/first.png' alt='[^]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/last.png' alt='[v]' /></a></li>
<li><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a></li>
<li><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a></li>
<li><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a></li>
<li><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a></li>
<li class='standout'><span><a href='../files/doc.html'>doc</a>/README</span></li>
</ul></div>
<!-- end of fixed guide -->
<a id='TOP' name='TOP'></a><h2 class='header'><a href='../mains.html'>root</a>/<a href='../files/doc.html'>doc</a>/README</h2>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><img class='icon' src='../icons/n_top.png' alt='[top]' /><a href='#BOTTOM'><img class='icon' src='../icons/bottom.png' alt='[bottom]' /></a><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+1 doc/README'  /> */</em>
<hr />
<pre>
<a id='L1' name='L1'></a>Contents
<a id='L2' name='L2'></a>--------
<a id='L3' name='L3'></a> 
<a id='L4' name='L4'></a>Introduction
<a id='L5' name='L5'></a>Dependencies
<a id='L6' name='L6'></a>Features
<a id='L7' name='L7'></a>Mini-documentation
<a id='L8' name='L8'></a>Where to get more information
<a id='L9' name='L9'></a>Reporting problems
<a id='L10' name='L10'></a> 
<a id='L11' name='L11'></a> 
<a id='L12' name='L12'></a>Introduction
<a id='L13' name='L13'></a>------------
<a id='L14' name='L14'></a> 
<a id='L15' name='L15'></a>GNU Midnight Commander (also referred to as MC) is a user shell with
<a id='L16' name='L16'></a>text-mode full-screen interface.  It can be run on the OS console,
<a id='L17' name='L17'></a>in xterm and other terminal emulators.
<a id='L18' name='L18'></a> 
<a id='L19' name='L19'></a>GNU Midnight Commander allows you to manage files while making most of
<a id='L20' name='L20'></a>you screen and giving you a clear representation of the filesystem, yet
<a id='L21' name='L21'></a>it's simple enough to be run over a telnet or ssh session.
<a id='L22' name='L22'></a> 
<a id='L23' name='L23'></a>GNU Midnight Commander is released under the GNU General Public
<a id='L24' name='L24'></a>License version 3 or any later version.  A copy of the file is
<a id='L25' name='L25'></a>included with this distribution package.
<a id='L26' name='L26'></a> 
<a id='L27' name='L27'></a> 
<a id='L28' name='L28'></a>Dependencies
<a id='L29' name='L29'></a>------------
<a id='L30' name='L30'></a> 
<a id='L31' name='L31'></a>Please read the file INSTALL for installation instructions
<a id='L32' name='L32'></a>and full list of dependencies.
<a id='L33' name='L33'></a> 
<a id='L34' name='L34'></a> 
<a id='L35' name='L35'></a>Features
<a id='L36' name='L36'></a>--------
<a id='L37' name='L37'></a> 
<a id='L38' name='L38'></a>GNU Midnight Commander was conceived as a free clone of John Socha's
<a id='L39' name='L39'></a>Norton Commander (TM).  It also takes the best from more recent software
<a id='L40' name='L40'></a>with similar interfaces.  GNU Midnight Commander comes with mouse support
<a id='L41' name='L41'></a>on xterm and optionally on the Linux console.
<a id='L42' name='L42'></a> 
<a id='L43' name='L43'></a>Some features are specific to the POSIX environment MC runs on, some are
<a id='L44' name='L44'></a>familiar to the users of similar software for other operating systems.
<a id='L45' name='L45'></a>The features include:
<a id='L46' name='L46'></a> 
<a id='L47' name='L47'></a>        * Built in Virtual File System: manipulate remote file systems
<a id='L48' name='L48'></a>          through the FTP and SMB protocols or over secure shell, browse
<a id='L49' name='L49'></a>          contents of tar, ar, rpm, zip, cpio, lha and rar archives just
<a id='L50' name='L50'></a>          like local files.
<a id='L51' name='L51'></a> 
<a id='L52' name='L52'></a>        * Almost all operations work with the virtual file system,
<a id='L53' name='L53'></a>          enabling you to do complex tasks, like viewing files in
<a id='L54' name='L54'></a>          archives on an FTP server.
<a id='L55' name='L55'></a> 
<a id='L56' name='L56'></a>        * Mouse support on most terminal emulators for X Window System
<a id='L57' name='L57'></a>          as well as on the Linux console.
<a id='L58' name='L58'></a> 
<a id='L59' name='L59'></a>        * Learn Keys: GNU Midnight Commander may be configured at run
<a id='L60' name='L60'></a>          time to support any kind of input keys for a given terminal,
<a id='L61' name='L61'></a>          making its operation possible even on most weird terminals.
<a id='L62' name='L62'></a> 
<a id='L63' name='L63'></a>        * Text and hex editors are available for you to use (hex editor
<a id='L64' name='L64'></a>          is a part of the viewer).
<a id='L65' name='L65'></a> 
<a id='L66' name='L66'></a>        * Hotlist allows you to keep a list of common visited locations,
<a id='L67' name='L67'></a>          including remote sites and directories inside archives.
<a id='L68' name='L68'></a> 
<a id='L69' name='L69'></a>        * Command completion: By pressing Alt-Tab in any place where a
<a id='L70' name='L70'></a>          filename or an executable are expected, GNU Midnight Commander
<a id='L71' name='L71'></a>          will complete the name for you.  If you press Alt-Tab for the
<a id='L72' name='L72'></a>          second time, you get a list box with all possible completions.
<a id='L73' name='L73'></a> 
<a id='L74' name='L74'></a>        * Subshell support: Run your commands by a real shell
<a id='L75' name='L75'></a>          interpreter.  GNU Midnight Commander interacts with bash,
<a id='L76' name='L76'></a>          tcsh and zsh to provide you with all of the facilities
<a id='L77' name='L77'></a>          available in your preferred shell.
<a id='L78' name='L78'></a> 
<a id='L79' name='L79'></a>        * Find file command can search for the file contents.
<a id='L80' name='L80'></a> 
<a id='L81' name='L81'></a>        * Background operations allow you to copy or move files from
<a id='L82' name='L82'></a>          any virtual file system while you do other tasks (i.e., you
<a id='L83' name='L83'></a>          can do background FTP copies).
<a id='L84' name='L84'></a> 
<a id='L85' name='L85'></a>        * FTP proxy is supported.
<a id='L86' name='L86'></a> 
<a id='L87' name='L87'></a>        * Linux file recovery: If you are using Linux, you can recover
<a id='L88' name='L88'></a>          deleted files from an ext2 or ext3 partition with the undelete
<a id='L89' name='L89'></a>          file system.  This is a low level file recovery function that
<a id='L90' name='L90'></a>          can recover files deleted by any program on Linux.
<a id='L91' name='L91'></a> 
<a id='L92' name='L92'></a>        * External panelization: You can run any arbitrary external
<a id='L93' name='L93'></a>          command and GNU Midnight Commander will display the output
<a id='L94' name='L94'></a>          generated as a file listing that can be manipulated as a
<a id='L95' name='L95'></a>          regular directory.
<a id='L96' name='L96'></a> 
<a id='L97' name='L97'></a>        * Emacs-like key bindings are used in all widgets.
<a id='L98' name='L98'></a> 
<a id='L99' name='L99'></a>        * Context dependent actions (open, view, edit) are available.
<a id='L100' name='L100'></a> 
<a id='L101' name='L101'></a>        * The built-in file viewer, together with the context dependent
<a id='L102' name='L102'></a>          actions is used to format man pages on the fly, coloring mail
<a id='L103' name='L103'></a>          messages and more.
<a id='L104' name='L104'></a> 
<a id='L105' name='L105'></a>        * The built-in editor supports syntax highlighting and external
<a id='L106' name='L106'></a>          actions, such as spell checking and formatting.
<a id='L107' name='L107'></a> 
<a id='L108' name='L108'></a> 
<a id='L109' name='L109'></a>Mini-documentation
<a id='L110' name='L110'></a>------------------
<a id='L111' name='L111'></a> 
<a id='L112' name='L112'></a>These are hints for the text mode edition:
<a id='L113' name='L113'></a> 
<a id='L114' name='L114'></a>* Use the F-Keys for invoking the commands in the function key bar.
<a id='L115' name='L115'></a>  If your terminal doesn't support F-keys, you can use the &lt;ESC digit&gt;
<a id='L116' name='L116'></a>  sequence to invoke the corresponding F-digit key.
<a id='L117' name='L117'></a> 
<a id='L118' name='L118'></a>* Tab changes the current panel.
<a id='L119' name='L119'></a> 
<a id='L120' name='L120'></a>* All input lines have emacs-like key-bindings (command history is
<a id='L121' name='L121'></a>  accessed through the M-p and M-n keys).
<a id='L122' name='L122'></a> 
<a id='L123' name='L123'></a>* The panels accept C-n, C-p for browsing the panel (like in Emacs).
<a id='L124' name='L124'></a> 
<a id='L125' name='L125'></a>* M-Enter copies the currently selected file name to the input line.
<a id='L126' name='L126'></a> 
<a id='L127' name='L127'></a>* M-Tab completes the current word (or tries to).
<a id='L128' name='L128'></a> 
<a id='L129' name='L129'></a>* The Virtual File System is a cute addition to the project, you may
<a id='L130' name='L130'></a>  browse in tar and compressed tar files as well as browsing remote
<a id='L131' name='L131'></a>  machines with the fish file system.
<a id='L132' name='L132'></a> 
<a id='L133' name='L133'></a>* Please read the manual page.
<a id='L134' name='L134'></a> 
<a id='L135' name='L135'></a>You can access the whole documentation online with the F1 key,
<a id='L136' name='L136'></a>although it's not as nice as the groff printed manual page :-)
<a id='L137' name='L137'></a> 
<a id='L138' name='L138'></a> 
<a id='L139' name='L139'></a>Where to get more information
<a id='L140' name='L140'></a>-----------------------------
<a id='L141' name='L141'></a> 
<a id='L142' name='L142'></a>There is a webpage for GNU Midnight Commander at
<a id='L143' name='L143'></a> 
<a id='L144' name='L144'></a>https://www.midnight-commander.org/
<a id='L145' name='L145'></a> 
<a id='L146' name='L146'></a>This page also has current information about mailing lists and some
<a id='L147' name='L147'></a>useful advices how to report bugs.
<a id='L148' name='L148'></a> 
<a id='L149' name='L149'></a>You can download the latest version of GNU Midnight Commander from
<a id='L150' name='L150'></a> 
<a id='L151' name='L151'></a>https://www.midnight-commander.org/downloads/
<a id='L152' name='L152'></a> 
<a id='L153' name='L153'></a> 
<a id='L154' name='L154'></a>Reporting problems
<a id='L155' name='L155'></a>------------------
<a id='L156' name='L156'></a> 
<a id='L157' name='L157'></a>You can report bug on our site, please read 
<a id='L158' name='L158'></a> 
<a id='L159' name='L159'></a>https://www.midnight-commander.org/wiki/doc/reportDefects
<a id='L160' name='L160'></a> 
<a id='L161' name='L161'></a>Also you can use mc mailing lists to discuss problems.
<a id='L162' name='L162'></a> 
<a id='L163' name='L163'></a>There are two mailing lists, mc@gnome.org and mc-devel@gnome.org.  Use
<a id='L164' name='L164'></a>mc-devel@gnome.org if you are prepared for a more technical discussion
<a id='L165' name='L165'></a>with the developers of the package, otherwise use mc@gnome.org.
<a id='L166' name='L166'></a> 
<a id='L167' name='L167'></a>Please don't sent HTML e-mail to either of those mailing lists.
<a id='L168' name='L168'></a> 
<a id='L169' name='L169'></a>Include the output of "mc --version", the operating system and the
<a id='L170' name='L170'></a>distribution (if applicable) you are using, the compiler and the
<a id='L171' name='L171'></a>configure flags used to compile the program (if you know them).
<a id='L172' name='L172'></a> 
<a id='L173' name='L173'></a>If the program crashed and produced a core dump, please provide a
<a id='L174' name='L174'></a>stack trace of the program.
<a id='L175' name='L175'></a> 
<a id='L176' name='L176'></a>You can do this by running gdb like this:
<a id='L177' name='L177'></a> 
<a id='L178' name='L178'></a>gdb mc core
<a id='L179' name='L179'></a>(gdb) where
</pre>
<hr />
<a id='BOTTOM' name='BOTTOM'></a>
<em class='comment'>/* <img class='icon' src='../icons/n_left.png' alt='[previous]' /><img class='icon' src='../icons/n_right.png' alt='[next]' /><img class='icon' src='../icons/n_first.png' alt='[first]' /><img class='icon' src='../icons/n_last.png' alt='[last]' /><a href='#TOP'><img class='icon' src='../icons/top.png' alt='[top]' /></a><img class='icon' src='../icons/n_bottom.png' alt='[bottom]' /><a href='../mains.html'><img class='icon' src='../icons/index.png' alt='[index]' /></a><a href='../help.html'><img class='icon' src='../icons/help.png' alt='[help]' /></a>&nbsp;<input type='text' readonly onfocus='this.select();' value='+179 doc/README'  /> */</em>
</body>
</html>
